Update release guide with multi-platform matrix strategy#5
Open
josebalius wants to merge 2 commits intomainfrom
Open
Update release guide with multi-platform matrix strategy#5josebalius wants to merge 2 commits intomainfrom
josebalius wants to merge 2 commits intomainfrom
Conversation
Replace the single-platform release workflow example with a matrix strategy that produces per-platform artifacts (e.g., engine-linux-x64.tar.gz, engine-darwin-arm64.tar.gz). This reflects the pattern used in practice where engines include platform-specific binaries. Co-authored-by: Copilot <223556219+Copilot@users.noreply.github.com>
There was a problem hiding this comment.
Pull request overview
Updates the integration guide’s “Releasing Your Engine” section to recommend multi-platform releases via a GitHub Actions matrix, producing one artifact per OS/architecture so engines with platform-specific binaries can be distributed correctly.
Changes:
- Expands the release workflow example from a single runner to a 5-target matrix (linux/darwin/win32 across x64/arm64 where applicable).
- Demonstrates passing
TARGET_PLATFORM/TARGET_ARCHinto the build step to drive platform-specific bundling. - Renames and uploads tarballs per platform/arch into a single GitHub Release.
💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.
You can also share your feedback on Copilot code review. Take the survey.
Add an inline YAML comment and a note explaining that the linux/arm64 matrix entry uses cross-building via TARGET_ARCH env var on an x64 runner, and that engines with native compilation steps may need actual arm64 runners or QEMU emulation. Co-authored-by: Copilot <223556219+Copilot@users.noreply.github.com>
Member
Author
|
Thanks for the bot review summary! All actionable feedback has been addressed. |
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Engines often include platform-specific binaries (e.g., the
copilotCLI), so a single-platform release isn't sufficient. This updates the "Releasing Your Engine" section in the integration guide to show a matrix strategy that produces per-platform artifacts.Changes
ubuntu-latestworkflow example with a matrix across 5 platform/arch targets (linux-x64, linux-arm64, darwin-arm64, darwin-x64, win32-x64)TARGET_PLATFORM/TARGET_ARCHenv vars so build scripts bundle the correct binariesengine-linux-x64.tar.gz) and uploads all to one GitHub ReleaseThis mirrors the approach we adopted in the example engine repo.